dxp-ux
Patch BillingAccount (TMF666) Update ebill flag
CASE 1 Unitary Test
Request to enable the ebill
URL
https://[localhost]:[port]/dxp-ux/v1/{businessId}/billingAccount/{id}Base URI Parameter
URL PARAMS
| name | type | description | required |
|---|---|---|---|
| businessId | string | 2 letter ISO 3166 country code (PR, JM, PA, etc.) identifying the business unit. | Y |
| id | string | Billing Account Number. | Y |
Headers
| name | value | description | required |
|---|---|---|---|
| client_id | string | The client_id identifying the channel. Minimum characters: 5 | Y |
| client_secret | string | Password associated with the client_id. Minimum characters: 5 | Y |
| X-Correlation-ID | string | An identifier for the current call chain that can be used to tie together log entries on multiple layers (e.g. client, server, mainframe). This identifier must be designed to be unique across all applications.Note - Mule default behavior creates a sample x-correlation-id field if value is not passed from client, API will use this value in case value is not passed in API request Pattern: ^[a-zA-Z0-9-+/=_]{16,64}$ Minimum characters: 16 Maximum characters: 64 | Y |
Request
curl --location --request PATCH 'https://nonprod.esb.cloud.lla.com/dev/dxp-ux/dxp-ux/v1/PR/billingAccount/21519514-21517998' \
--header 'X-Correlation-ID: 644e1dd7-2a7f-18fb-b8ed-ed78c3F92c2gk' \
--header 'client_id: xxx' \
--header 'client_secret: yyy' \
--header 'Content-Type: application/json' \
--data-raw '{
"relatedParty": [
{
"id": "15468766786",
"@type": "msisdn"
},
{
"@type": "channel",
"name": "Digital"
}
],
"billStructure": {
"presentationMedia": [
{
"@type": "non-eBill"
}
]
}
}'Definitions
| name | value | description | required |
|---|---|---|---|
| relatedParty | array | related party array | Y |
| relatedParty.id | string | unique identifier of related party | N |
| relatedParty.@type | string | type of the related party | Y* |
| relatedParty.name | string | name of the realted party | Y* |
| billStructure | Object | bill structure object | Y |
| billStructure.presentationMedia | Array | details of presentation media | Y |
| billStructure.presentationMedia.@type | String | type of bill subscription | Y |
[ 200 ]
OK - updateBillingAccount request processed successfully, response body contains an entity corresponding to the requested resource.
Response
{
"status": 200,
"description": "Request to update the Ebill Flag received"
}Definitions
| name | value | description | required |
|---|---|---|---|
| status | number | status code of the response | N |
| description | string | status description of the response | N |
[ 200 ] FIXED
OK - updateBillingAccount request processed successfully, response body contains an entity corresponding to the requested resource.
Request
{
"billStructure": {
"presentationMedia": [
{
"name": "email"
}
]
}
}Response
{
"id": "8211990010042315",
"state": "acknowledged",
"billStructure": {
"presentationMedia": [
{
"name": "email"
}
]
}
}FIXED Definitions
| name | value | description | required |
|---|---|---|---|
| id | string | unique identifier | Y |
| state | string | state of the operation | Y |
| billStructure | Object | bill structure object | Y |
| billStructure.presentationMedia | Array | details of presentation media. | Y |
| billStructure.presentationMedia.name | String | Name of the referred entity.Possible values are | Y |